Getting Incident Users and User Groups¶

To retrieve user information.

GET

https://Logpoint-IP/get_users

Parameter	Value Type	Description
username	String	Logpoint username
secret_key	String	Access key to uniquely identify an authorized user. Go to Finding the Access Key for information on retrieving it.

Parameters¶

Parameters are data sent along with the request to retrieve information. It should be included in the request body as raw text. Content-Type, Content-Length, and Host must be passed in the request header. Content-Type should be application/json.

{
        "username": "John",
        "secret_key": "a1b2c3d4e5f6g7h8i9j0k1",
        }

Request Example¶

Getting Users and User Groups using Postman.¶

cURL Code¶

curl --location --request GET 'https://10.45.10.172/get_users' \
--header 'Content-Type: application/json' \
--data '{
    "username": "John",
    "secret_key": "a1b2c3d4e5f6g7h8i9j0k1"
}'

Sample JSON response¶

  {"success": true,
"users": [
  {
    "usergroups": [
      {
        "id": "5bebd9fdd8aaa42840edc84f",
        "name": "Logpoint Administrator"
      }
    ],
    "id": "5bebd9fdd8aaa42840edc853",
    "name": "admin"
  },
  {
    "usergroups": [
      {
        "id": "5bebd9fdd8aaa42840edc84f",
        "name": "Logpoint Administrator"
      }
    ],
    "id": "5e15969ff5f33401e60fe757",
    "name": "sample admin"
  },
  {
    "usergroups": [
      {
        "id": "5bebd9fdd8aaa42840edc850",
        "name": "User Account Administrator"
      }
    ],
    "id": "5e1bef95f5f33436dd3a9f07",
    "name": "sample user"
  }
]
  }

Response Parameters¶

Response Parameters	Value Type	Description
success	Boolean	Returns True if the API call is successful; otherwise it returns False.
users	Array of objects	List of user details and associated user groups.
usergroups	Array of objects	List of user group objects that the user belongs to.
incident_ids	String	Unique identifier of user and usergroups.
name	String	Name of user and usergroups.

Helpful?